<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class IQueryTransformations</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface IQueryTransformations</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Provides methods to find named modifications or suggestions contained</p>
<p class="description"><p>in the query result. A query transformation can be one of two types:  a modifications or a suggestion. A modification results in changes  to the query that is submitted to the search engine while a suggestion  leaves the query unchanged and is merely returned together with the result as  information on how to potentially improve the query.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: IQueryTransformations.html 20 2010-01-28 14:33:07Z kenn.north $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---result---IQueryTransformations.php.html">/src/sde/fastsearch/result/IQueryTransformations.php</a> (line <span class="field">38</span>)
		</p>
		
				
		<pre><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a>
   |
   --IQueryTransformations</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																						
				<div class="method-definition">
											<span class="method-result">ArrayObject</span>
										<a href="#getAllQueryTransformations" title="details" class="method-name">getAllQueryTransformations</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IQueryTransformation.html">IQueryTransformation</a></span>
										<a href="#getModification" title="details" class="method-name">getModification</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">ArrayObject</span>
										<a href="#getModifications" title="details" class="method-name">getModifications</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">ArrayObject</span>
										<a href="#getModificationsByName" title="details" class="method-name">getModificationsByName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getSubmittedQuery" title="details" class="method-name">getSubmittedQuery</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IQueryTransformation.html">IQueryTransformation</a></span>
										<a href="#getSuggestion" title="details" class="method-name">getSuggestion</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">ArrayObject</span>
										<a href="#getSuggestions" title="details" class="method-name">getSuggestions</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">ArrayObject</span>
										<a href="#getSuggestionsByName" title="details" class="method-name">getSuggestionsByName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IQueryTransformation.html">IQueryTransformation</a></span>
										<a href="#getTransformation" title="details" class="method-name">getTransformation</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">ArrayObject</span>
										<a href="#getTransformationsByName" title="details" class="method-name">getTransformationsByName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#hasModification" title="details" class="method-name">hasModification</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#hasSuggestion" title="details" class="method-name">hasSuggestion</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#hasTransformation" title="details" class="method-name">hasTransformation</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetAllQueryTransformations" id="getAllQueryTransformations"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAllQueryTransformations</span> (line <span class="line-number">44</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an ArrayObject containing all the query transformations in this  query transformations.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ArrayObject</span>
		<span class="method-name">
			getAllQueryTransformations
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetModification" id="getModification"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getModification</span> (line <span class="line-number">67</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the final modification done by a given query transformer.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IQueryTransformation.html">IQueryTransformation</a></span>
		<span class="method-name">
			getModification
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetModifications" id="getModifications"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getModifications</span> (line <span class="line-number">74</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an ArrayObject containing all the query transformations in this  query transformations that are modifications.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ArrayObject</span>
		<span class="method-name">
			getModifications
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetModificationsByName" id="getModificationsByName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getModificationsByName</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns all the modifications done by a given query transformer.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ArrayObject</span>
		<span class="method-name">
			getModificationsByName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetSubmittedQuery" id="getSubmittedQuery"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSubmittedQuery</span> (line <span class="line-number">87</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the query that was submitted to the search engine</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getSubmittedQuery
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSuggestion" id="getSuggestion"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSuggestion</span> (line <span class="line-number">93</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the final suggestion returned from a given query transformer.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IQueryTransformation.html">IQueryTransformation</a></span>
		<span class="method-name">
			getSuggestion
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetSuggestions" id="getSuggestions"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSuggestions</span> (line <span class="line-number">100</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an ArrayObject containing all the query transformations in this  query transformations that are suggestions.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ArrayObject</span>
		<span class="method-name">
			getSuggestions
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSuggestionsByName" id="getSuggestionsByName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSuggestionsByName</span> (line <span class="line-number">107</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns all the suggestions returned by a given query transformer.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ArrayObject</span>
		<span class="method-name">
			getSuggestionsByName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetTransformation" id="getTransformation"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getTransformation</span> (line <span class="line-number">52</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a query transformation done by given query transformer of all</p>
<p class="description"><p>types (not only modifications and suggestions)</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IQueryTransformation.html">IQueryTransformation</a></span>
		<span class="method-name">
			getTransformation
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetTransformationsByName" id="getTransformationsByName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getTransformationsByName</span> (line <span class="line-number">60</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns all query transformations done by given query transformer of all</p>
<p class="description"><p>types (not only modifications and suggestions)</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ArrayObject</span>
		<span class="method-name">
			getTransformationsByName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhasModification" id="hasModification"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">hasModification</span> (line <span class="line-number">123</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if this query transformations contain a query  transformation named $name and this query transformation is a modification.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			hasModification
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhasSuggestion" id="hasSuggestion"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">hasSuggestion</span> (line <span class="line-number">131</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if this query transformations contain a query  transformation named $name and this query transformation is a suggestion.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			hasSuggestion
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhasTransformation" id="hasTransformation"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">hasTransformation</span> (line <span class="line-number">115</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if this query transformations contain a query  transformation named $name.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			hasTransformation
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../sde_fastsearch_result/IResultObject.html#methodprepareUnset">IResultObject::prepareUnset()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:36:05 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>